/*
 * Java Genetic Algorithm Library (@__identifier__@).
 * Copyright (c) @__year__@ Franz Wilhelmstötter
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Author:
 *    Franz Wilhelmstötter (franz.wilhelmstoetter@gmail.com)
 */
package io.jenetics.incubator.metamodel.type;

import io.jenetics.incubator.metamodel.access.Carried;
import io.jenetics.incubator.metamodel.access.Size;

/**
 * Represents collection types. Collection types have a size and are able to
 * iterate over its element. The iterator elements are from instances of
 * {@link #componentType()}.
 *
 * @author <a href="mailto:franz.wilhelmstoetter@gmail.com">Franz Wilhelmstötter</a>
 * @version 8.3
 * @since 8.3
 */
public sealed interface CollectionType
	extends EnclosingType
	permits IndexedType, SetType, MapType
{

	/**
	 * Return the component type, e.g., Array, List, Set or Optional.
	 *
	 * @return the container type
	 */
	@Override
	Class<?> type();

	/**
	 * The collection size.
	 *
	 * @return the collection size
	 */
	Carried<Size> size();

	/**
	 * The element iterable.
	 *
	 * @return the element iterable
	 */
	Carried<Iterable<Object>> iterable();

}
